1 /* ====================================================================
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 2000 The Apache Software Foundation. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution,
20 * if any, must include the following acknowledgment:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowledgment may appear in the software itself,
24 * if and wherever such third-party acknowledgments normally appear.
25 *
26 * 4. The names "Apache" and "Apache Software Foundation" must
27 * not be used to endorse or promote products derived from this
28 * software without prior written permission. For written
29 * permission, please contact apache@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache",
32 * nor may "Apache" appear in their name, without prior written
33 * permission of the Apache Software Foundation.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>;.
53 *
54 * Portions of this software are based upon public domain software
55 * originally written at the National Center for Supercomputing Applications,
56 * University of Illinois, Urbana-Champaign.
57 */
58
59 package net.sourceforge.jane;
60
61 import java.io.InputStream;
62 import java.io.IOException;
63 import net.sourceforge.jane.util.JavaLangUtils;
64
65 /***
66 * Locates '.java' files from a source path.
67 *
68 * @author Calvin Yu
69 */
70 public class SourcePathArtifactLocator implements ArtifactLocator
71 {
72
73 static final public String TYPE = "sources";
74
75 private CompositeArtifactPath path;
76
77 /***
78 * Create a new <code>SourcePathArtifactLocator</code>.
79 */
80 public SourcePathArtifactLocator()
81 {
82 path = new CompositeArtifactPath();
83 }
84
85 /***
86 * Append a path.
87 */
88 public void appendPath(String aPath)
89 throws InvalidPathException
90 {
91 path.addPath(ArtifactPath.resolvePath(aPath));
92 }
93
94 /***
95 * Returns the type.
96 */
97 public String getType()
98 {
99 return TYPE;
100 }
101
102 /***
103 * Returns an input stream to the given path.
104 */
105 public InputStream getInputStream(String className)
106 throws IOException
107 {
108 return path.findArtifact(toRelativePath(className));
109 }
110
111 /***
112 * Returns the path to the source of the given class name.
113 */
114 public String getPath(String className)
115 {
116 return path.getPathToArtifact(toRelativePath(className));
117 }
118
119 /***
120 * Returns <code>true</code> if this locator can find the given class.
121 */
122 public boolean canFindClass(String className)
123 {
124 return getPath(className) != null;
125 }
126
127 /***
128 * Converts a class name to a relative artifact path.
129 */
130 private String toRelativePath(String className)
131 {
132 return JavaLangUtils.getRelativePathToSource(className);
133 }
134
135 }
136
This page was automatically generated by Maven